Skip to content

docs(apple): restructure install docs and add SentryObjC#17926

Merged
philprime merged 9 commits into
masterfrom
philprime/apple-install-restructure-sentryobjc
Jun 3, 2026
Merged

docs(apple): restructure install docs and add SentryObjC#17926
philprime merged 9 commits into
masterfrom
philprime/apple-install-restructure-sentryobjc

Conversation

@philprime
Copy link
Copy Markdown
Member

@philprime philprime commented May 29, 2026

Restructures the Apple SDK installation docs to clearly separate pre-compiled
and compile-from-source products, and documents the new SentryObjC wrapper
(shipping in 9.16.0) for Objective-C/ObjC++ projects that can't use Clang modules.

SPM page now has three sections: Pre-compiled (Recommended) for Sentry,
Sentry-Dynamic, SentrySwiftUI; Compile from Source for SentrySPM and
NoUIFramework; and SentryObjC with installation and configuration examples.

Manual Install page adds SentryObjC.xcframework.zip and
SentryObjC-Dynamic.xcframework.zip to the download list with usage guidelines.

Install index adds an info callout directing ObjC++/no-modules users to the
SentryObjC section.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel
Copy link
Copy Markdown

vercel Bot commented May 29, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jun 3, 2026 1:54pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Jun 3, 2026 1:54pm

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team May 29, 2026 13:38
Comment thread docs/platforms/apple/common/install/swift-package-manager.mdx Outdated
Copy link
Copy Markdown
Contributor

@itaybre itaybre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with some comments

Comment thread docs/platforms/apple/common/install/index.mdx Outdated
Comment thread docs/platforms/apple/common/install/manual-install.mdx
philprime and others added 4 commits June 2, 2026 13:41
Reorganize the SPM page into Pre-compiled, Compile from Source, and
SentryObjC sections so users can quickly find the right product. Add
SentryObjC xcframeworks to the manual install page and a callout on
the install index for ObjC++/no-modules projects.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
SentryObjC via SPM compiles from source; only the dynamic xcframework
is available pre-compiled. Remove the non-existent static xcframework
and clarify the SPM product compiles from source.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
SwiftUI view performance tracking is now included in the main Sentry
product. Mark SentrySwiftUI as deprecated in both SPM and manual
install pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@philprime philprime force-pushed the philprime/apple-install-restructure-sentryobjc branch from b2f7350 to 9f1095f Compare June 2, 2026 11:41
@codeowner-assignment codeowner-assignment Bot requested a review from a team June 2, 2026 11:41
…ribution channels

Apply itaybre's suggestion to clarify `@import` as "semantic imports", add
SentryObjC-Static xcframework to manual install, and expand the SPM section
with a "Why SentryObjC?" explainer and pre-compiled binary target products.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ules scenarios

Adds missing configuration details derived from the sentry-cocoa sample apps:
- SentryObjC-Static requires `-lc++` linker flag and an empty .swift file
- Clang modules disabled / ObjC++ needs explicit framework linking and #import
- SentryObjC-Dynamic supports @import module imports

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@philprime philprime marked this pull request as ready for review June 3, 2026 12:42
@philprime philprime requested a review from itaybre June 3, 2026 12:43
Comment thread docs/platforms/apple/common/install/swift-package-manager.mdx
Comment thread docs/platforms/apple/common/install/swift-package-manager.mdx
philprime and others added 2 commits June 3, 2026 15:07
…instrumentation page

SwiftUI view performance tracking is now included in the main Sentry
SDK. Replace all `import SentrySwiftUI` with `import Sentry` and remove
the outdated install instructions that contradicted the deprecation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Comment thread docs/platforms/apple/common/install/manual-install.mdx Outdated
Copy link
Copy Markdown
Contributor

@itaybre itaybre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, some comments to double check/ for later but not urgent

Comment thread docs/platforms/apple/common/install/swift-package-manager.mdx
Comment thread docs/platforms/apple/common/install/swift-package-manager.mdx
…tatic

Replace the dummy .swift file approach with explicit linker flags
(-lswiftCore, -force_load libswiftCompatibility56.a) as the primary
method, matching getsentry/sentry-cocoa#7999. The dummy file is now
documented as a fallback. Also notes that targets with existing .swift
files only need -lc++.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@codeowner-assignment codeowner-assignment Bot requested a review from a team June 3, 2026 13:43
@philprime philprime merged commit ac2d57e into master Jun 3, 2026
21 checks passed
@philprime philprime deleted the philprime/apple-install-restructure-sentryobjc branch June 3, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants